5.1 Introdução

Na Kedu Tech, oferecemos aos nossos clientes o serviço de emissão de boletos. Durante a nossa integração podemos fornecer ao cliente a possibilidade de gerenciar boletos via API.

Boletos

A troca de informações sobre boletos entre o cliente e o banco tradicionalmente é feita por meio de arquivos de remessa e retorno. Na Kedu Tech pensamos em facilitar seu trabalho, por este motivo esta troca de informações é feita por API. Além disso, nossas APIS também oferecem serviços de consulta de boletos via request com resposta em JSON para uma lista detalhada dos boletos cadastrados, seus status, entre outros parâmetros.

Fluxo para emissão de boletos

Objeto Billing

Campo	Tipo	Descrição
active	Boolean!	Status de Ativação
amountPaid	Decimal	Valor pago
apiRequestLogs	[ApiRequestLog!]	No description
atmPayment	AtmPayment	Dados do pagamento em ATM
atmPaymentId	Int	Id do pagamento em ATM
barcode	String	Código de barras
barcodeBase64	String!	No description
barcodeUrl	String	Url do código de barras
billingAgreements	[BillingAgreement!]!	Acordos associados à cobrança
billingStatus	BillingStatus	Status da cobrança
calculatedFineValue	Decimal!	No description
calculatedIncreaseValue	Decimal!	No description
cancelAfterRegister	Boolean	Marca a cobrança para ser cancelada após o registro
cancellationDescription	String	Descrição do motivo de cancelamento
cancellationReason	CancellationReason	Motivo de cancelamento
changes	[LogHistory!]!	Histórico de alterações
competenceDate	DateTime	Data de competência
creationDate	DateTime!	Data de Criação
deductedDiscounts	[DeductedDiscount!]	Descontos deduzidos
deleted	Boolean!	Status de Deleção
description	String	Descrição
digitableLine	String	Linha digitável
discount	Decimal	Desconto
documentCode	String	Código do documento
dueDate	DateTime!	Data de vencimento
externalId	Int	Id Externo
externalToken	String	Token externo
financialIntegration	FinancialIntegration	Dados da integração financeira
financialIntegrationId	Int	Id da integração financeira
financialOwner	FinancialOwner!	Dados do responsável financeiro
financialOwnerId	Int!	Id do responsável financeiro
fineValue	Decimal	Multa
firstBilling	Billing	Primeira cobrança
firstBillingId	Int	Id da primeira cobrança
graphQLRequestLogs	[GraphQLRequestLog!]	No description
hasAnyManualPayment	Boolean!	No description DeprecatedUsar a propriedade 'isManualPayment'
hasRefund	Boolean	Marca se a cobrança foi estornada
id	Int!	Id do objeto da Requisição
interestPercentage	Decimal	Porcentagem de Juros
interestValue	Decimal	Juros
isFromAgreement	Boolean	Indica se o boleto foi gerado por um acordo
isManualPayment	Boolean!	Indicador de pagamento manual
itIsPayable	Boolean!	No description
itIsPrintable	Boolean!	No description
itIsReissuable	Boolean!	No description
lastUpdateDate	DateTime	Data da ultima atualização
nn	String	Nosso número
originalValue	Decimal!	Valor original
parentBilling	Billing	Cobrança pai
parentBillingId	Int	Id da cobrança pai
paymentDate	DateTime	Data do pagamento
paymentPlan	PaymentPlan!	Dados do plano de pagamento
paymentPlanId	Int!	Id do plano de pagamento
paymentType	PaymentType	Tipo de pagamento
pixCode	String	Código do Pix
punctualDiscounts	[PunctualDiscount!]	Descontos pontualidade
refId	UUID!	Id da Referência
refundDate	DateTime	Data do estorno
refundDescription	String	Descrição do motivo de estorno
refundReason	RefundReason	Motivo do estorno
refundValue	Decimal	Valor estornado
reissueDescription	String	Descrição do motivo da 2ª via
reissueReason	ReissueReason	Motivo da 2ª via
updatedComptenceDate	DateTime!	No description
updatedValue	Decimal!	No description
value	Decimal!	Valor